Skip to content

docs: fix doc & type definitions in the projectors module #1221

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Draft
wants to merge 20 commits into
base: master
Choose a base branch
from
Draft

docs: fix doc & type definitions in the projectors module #1221

wants to merge 20 commits into from

Conversation

bonjourmauko
Copy link
Member

@bonjourmauko bonjourmauko commented Sep 16, 2024 •
edited
Loading

Fixes #1239
Depends on #1224
Depended upon by #1146

Technical changes

  • Fix doc & type definitions in the projectors module

@bonjourmauko bonjourmauko added level:starter Suited for beginners and new contributors kind:refactor Refactoring and code cleanup labels Sep 16, 2024
@bonjourmauko bonjourmauko requested review from a team September 16, 2024 23:27
@bonjourmauko bonjourmauko self-assigned this Sep 16, 2024
@coveralls
Copy link

coveralls commented Sep 16, 2024 •
edited
Loading

Coverage Status

coverage: 74.499% (+0.05%) from 74.452%
when pulling 584e97f on fix-mypy-chekcs-proj
into 4a99cb4 on fix-mypy-checks-enums.

@bonjourmauko bonjourmauko force-pushed the fix-mypy-checks-ent branch 3 times, most recently from d2960a8 to a7904e5 Compare September 17, 2024 00:12
@bonjourmauko bonjourmauko force-pushed the fix-mypy-checks-ent branch 2 times, most recently from 33465fc to 7b37709 Compare September 17, 2024 03:16
@bonjourmauko bonjourmauko mentioned this pull request Sep 17, 2024
Draft
@bonjourmauko bonjourmauko changed the title Fix doc & type definitions in the projectors module [11/17] Fix doc & type definitions in the projectors module Sep 17, 2024
@bonjourmauko bonjourmauko marked this pull request as draft September 17, 2024 22:36
@bonjourmauko bonjourmauko removed request for a team September 17, 2024 22:36
@bonjourmauko bonjourmauko changed the base branch from fix-mypy-checks-ent to fix-mypy-checks-periods September 17, 2024 22:39
@bonjourmauko bonjourmauko mentioned this pull request Sep 18, 2024
Open
17 tasks
@bonjourmauko bonjourmauko force-pushed the fix-mypy-checks-periods branch from 3601736 to 9317b7f Compare September 18, 2024 11:47
@bonjourmauko bonjourmauko mentioned this pull request Sep 25, 2024
Open
32 tasks
benoit-cty
benoit-cty reviewed Sep 27, 2024
View reviewed changes
openfisca_core/commons/types.py
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why re-creating types here instead of importing them directly ?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm still unsure what is the best way to go.

@bonjourmauko bonjourmauko changed the title [9/17] Fix doc & type definitions in the projectors module docs: fix doc & type definitions in the projectors module Sep 30, 2024
@bonjourmauko bonjourmauko added kind:docs Add or improvement of documentation and removed kind:refactor Refactoring and code cleanup labels Sep 30, 2024
@bonjourmauko bonjourmauko force-pushed the fix-mypy-checks-enums branch 2 times, most recently from 83e521c to 738652a Compare October 5, 2024 00:47
@bonjourmauko bonjourmauko force-pushed the fix-mypy-checks-enums branch from 738652a to c54d3a5 Compare October 9, 2024 17:56
@bonjourmauko bonjourmauko changed the base branch from fix-mypy-checks-enums to docs/add-docs-to-experimental October 11, 2024 11:51
benjello
benjello reviewed Oct 14, 2024
View reviewed changes
openfisca_core/periods/helpers.py
>>> period(DateUnit.ETERNITY)
Period((<DateUnit.ETERNITY: 'eternity'>, Instant((1, 1, 1)), inf))
Period((<DateUnit.ETERNITY: 'eternity'>, Instant((1, 1, 1)), 0))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be -1 here ?

benjello
benjello reviewed Oct 14, 2024
View reviewed changes
openfisca_core/periods/helpers.py

# We return an "eternity-period", for example
# ``<Period(('eternity', <Instant(1, 1, 1)>, inf))>``.
# ``<Period(('eternity', <Instant(1, 1, 1)>, 0))>``.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be -1 here ?

@bonjourmauko
Copy link
Member Author

@benjello @benjello I marked this one as a draft because it got outdated respect to the other PRs required to move one with this one. I still need to merge things here, and then I'll ask you again for a review. Sorry.

@bonjourmauko bonjourmauko force-pushed the docs/add-docs-to-experimental branch 2 times, most recently from 0da8886 to 0e10d12 Compare October 16, 2024 15:26
Base automatically changed from docs/add-docs-to-experimental to master October 17, 2024 12:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@benjello benjello benjello left review comments

@benoit-cty benoit-cty benoit-cty left review comments

At least 1 approving review is required to merge this pull request.

Assignees

@bonjourmauko bonjourmauko

Labels

kind:docs Add or improvement of documentation level:starter Suited for beginners and new contributors

Projects

OpenFisca International
Status: Discussing / Discovering

Milestone

Improved doc, style & linting

Development

Successfully merging this pull request may close these issues.

4 participants

@bonjourmauko @coveralls @benjello @benoit-cty